Tangoe ServiceNow API

1.0.x
(0 reviews)

Response Structure

All GET request parameters are generated as query parameters. POST and PUT data passed in request body (application/json) responses from the API are always JSON.

Successful request

HTTP/1.1 200 OK
Content-Type: application/json
{
  "result": []
}

All responses from the API server are JSON with the content-type application/json unless explicitly stated otherwise. A successful 200 OK response always has a JSON response body with a result key contains the full response payload.

Response Code 204 No Content with empty response body will be produced if there are no result to the request.

HTTP/1.1 204 No Content
Content-Type: application/json
{}

Failed request

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
  "error": {
    "detail": "Negative offset is not supported",
    "message": "offset is -9"
  },
  "status": "failure"
}

A failure response is preceded by the corresponding 40x or 50x HTTP header. The status key in the response envelope contains the value failure. The error key contains detailed payload with fields like detail and message which provides textual description of the error/exception. There may be an optional result key with additional payload.

Reviews